home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIAutoCompleteInput.idl < prev    next >
Text File  |  2006-05-08  |  5KB  |  160 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is mozilla.org code.
  15.  *
  16.  * The Initial Developer of the Original Code is
  17.  * Netscape Communications Corporation.
  18.  * Portions created by the Initial Developer are Copyright (C) 2001
  19.  * the Initial Developer. All Rights Reserved.
  20.  *
  21.  * Contributor(s):
  22.  *   Joe Hewitt <hewitt@netscape.com> (Original Author)
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39. #include "nsIAutoCompleteController.idl"
  40.  
  41. interface nsIAutoCompletePopup;
  42.  
  43. [scriptable, uuid(e312267f-8f57-43e8-a904-ff9b5d3f5aef)]
  44. interface nsIAutoCompleteInput : nsISupports
  45. {  
  46.   /*
  47.    * The result view that will be used to display results
  48.    */
  49.   readonly attribute nsIAutoCompletePopup popup;
  50.   
  51.   /*
  52.    * The controller.
  53.    */
  54.   readonly attribute nsIAutoCompleteController controller;
  55.  
  56.   /* 
  57.    * Indicates if the popup is currently open
  58.    */
  59.   attribute boolean popupOpen;
  60.  
  61.   /*
  62.    * Option to disable autocomplete functionality
  63.    */ 
  64.   attribute boolean disableAutoComplete;
  65.   
  66.   /* 
  67.    * If a search result has its defaultIndex set, this will optionally
  68.    * try to complete the text in the textbox to the entire text of the
  69.    * result at the default index as the user types
  70.    */
  71.   attribute boolean completeDefaultIndex;
  72.  
  73.   /*
  74.    * complete text in the textbox as the user selects from the dropdown
  75.    * options if set to true
  76.    */
  77.   attribute boolean completeSelectedIndex;
  78.  
  79.   /* 
  80.    * Option for completing to the default result whenever the user hits
  81.    * enter or the textbox loses focus
  82.    */
  83.   attribute boolean forceComplete;
  84.     
  85.   /*
  86.    * Option to open the popup only after a certain number of results are available
  87.    */
  88.   attribute unsigned long minResultsForPopup;
  89.   
  90.   /*
  91.    * The maximum number of rows to show in the autocomplete popup.
  92.    */
  93.   attribute unsigned long maxRows;
  94.  
  95.   /*
  96.    * Option to show a second column in the popup which contains
  97.    * the comment for each autocomplete result
  98.    */
  99.   attribute unsigned long showCommentColumn;
  100.  
  101.   /* 
  102.    * Number of milliseconds after a keystroke before a search begins
  103.    */
  104.   attribute unsigned long timeout;
  105.  
  106.   /*
  107.    * An extra parameter to configure searches with.
  108.    */
  109.   attribute AString searchParam;
  110.  
  111.   /*
  112.    * The number of autocomplete session to search
  113.    */
  114.   readonly attribute unsigned long searchCount;
  115.   
  116.   /*
  117.    * Get the name of one of the autocomplete search session objects
  118.    */
  119.   ACString getSearchAt(in unsigned long index);
  120.  
  121.   /*
  122.    * The value of text in the autocomplete textbox
  123.    */
  124.   attribute AString textValue;
  125.  
  126.   /*
  127.    * Report the starting index of the cursor in the textbox
  128.    */
  129.   readonly attribute long selectionStart;
  130.  
  131.   /*
  132.    * Report the ending index of the cursor in the textbox
  133.    */
  134.   readonly attribute long selectionEnd;
  135.  
  136.   /*
  137.    * Select a range of text in the autocomplete textbox
  138.    */
  139.   void selectTextRange(in long startIndex, in long endIndex);
  140.  
  141.   /*
  142.    * Notification that the search concluded successfully
  143.    */
  144.   void onSearchComplete();
  145.  
  146.   /*
  147.    * Notification that the user selected and entered a result item
  148.    *
  149.    * @return True if the user wishes to prevent the enter
  150.    */
  151.   boolean onTextEntered();
  152.  
  153.   /*
  154.    * Notification that the user cancelled the autocomplete session
  155.    *
  156.    * @return True if the user wishes to prevent the revert
  157.    */
  158.   boolean onTextReverted();
  159. };
  160.